Wiki

Clone wiki

atlasboard / Installing Atlasboard

OPTION A) Safest and easiest way

This will pull the latest from the npm registry. This is updated less often but it is more stable.

npm install -g atlasboard

Once you install it as a global module (-g) option, you can already open a shell and type atlasboard

OPTION B) You want to play with the latest uhh?

If you want to get the latest from master though (and contribute or play with the latest) and symlink it to be able to use it globally, you need to do this:

  • git clone git@bitbucket.org:atlassian/atlasboard.git atlasboard
  • cd atlasboard
  • npm link
  • npm install

Now you can execute atlasboard from anywhere, and your local copy will be used.

What's next?

The next logical step is to create your first dashboard (Atlasboard is pretty much a generator)

atlasboard new mydashboard

###Requirements###

  • Node.js
  • a git client

Note: for windows users it may be necessary to edit ...\atlasboard\lib\package-dependency-manager.js and ...atlasboard\lib\cli\atlasboard.js to use 'npm.cmd' instead of 'npm'.

Updated